/*
 * Created on Feb 19, 2009
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 *
 * Copyright @2009 the original author or authors.
 */
package org.fest.javafx.desktop.format;

import com.sun.scenario.scenegraph.fx.FXNode;

/**
 * Understands a formatter that returns a <code>String</code> representation of a given JavaFX node
 *
 * @author Yvonne Wang
 */
public interface NodeFormatter {

  /**
   * Returns a <code>String</code> representation of the given node.
   * @param node the given node.
   * @return a <code>String</code> representation of the given node.
   */
  String format(FXNode node);

  /**
   * Returns the supported type of object this formatter supports. This method is used by
   * <code>{@link Formatting}</code> to uniquely identify a formatter.
   * @return the supported type of object this formatter supports.
   */
  Class<?> supportedType();
}
